HandStack 프로젝트 큰 그림 그리기

잘 정리된 사무실 같은 HandStack

HandStack 프로젝트는 마치 잘 정리된 사무실과 같습니다. 각 디렉토리가 명확한 역할을 가지고 있어 전체 구조를 이해하기 쉽습니다. 예를 들어 다음과 같이 설명할 수 있습니다

• 1.WebHost: 회사의 정문과 안내 데스크 역할
• 2.Modules: 각 업무를 담당하는 전문 부서들
• 3.Infrastructure: 모든 부서가 공유하는 핵심 인프라
• 4.Tool: 업무 효율성을 높이는 각종 도구함
• Solution Items: 전사 공통 규정 및 정책 문서

1.WebHost: 프로젝트의 시작점

• 서버 실행의 진입점(Entry Point) 역할을 하는 웹 호스트 프로젝트가 있습니다.
• 웹 애플리케이션의 환경 설정, 시작, 업무 모듈 서빙을 모두 이곳에서 담당합니다.
  • 비유하자면, 건물의 정문이자 모든 방문객을 맞는 안내 데스크와 같습니다.
• ack 서버와 forbes 개발 템플릿이 있습니다.

2.Modules: 핵심 비즈니스 로직

• 도메인 기반의 실제 업무 기능(모듈)들이 모여있는 곳입니다.
• 각 모듈은 독립적으로 Application, Domain, Persistence, API 계층을 가질 수 있습니다.
• 예시: 게시판 관리, 사용자 관리, 주문 처리 등
• 비유하자면, 회계팀, 인사팀, 개발팀처럼 각자의 역할을 가진 ‘업무 부서’에 해당합니다.
• 하나의 배포 단위 내에서 기능별로 모듈을 분리하는 모듈러 모놀리식 아키텍처의 핵심입니다.

3.Infrastructure: 공통 기반 시설

• 서버 프로그램 기능을 위한 공통 인프라스트럭처 레이어입니다.
• 데이터베이스 연결, 로깅, 인증 처리처럼 여러 모듈이 공유하는 시스템 자원이나 구현체를 제공합니다.
• 비유하자면, 모든 부서가 함께 사용하는 ‘회의실’이나 ‘서버실’과 같은 공용 시설입니다.
• HandStack 개발과 운영에 필요한 공통 API 집합입니다.

syn.js 라이브러리는 ack 프로젝트에 포함됩니다.
syn.uicontrols.js 라이브러리를 wwwroot 모듈에 포함됩니다.

4.Tool: 개발 보조 도구

• 프로젝트 개발 및 배포, 유지보수를 위한 보조 도구와 유틸리티를 모아놓은 곳입니다.
• CLI 도구, 데이터베이스 마이그레이션 스크립트 등이 포함될 수 있습니다.
• 비유하자면, 업무 효율을 높여주는 ‘사무용품’ 또는 ‘공구함’과 같습니다.
• 모든 기능은 자동화와 시스템 통합을 위해 CLI 를 우선하여 개발합니다.
  • Node.js, .NET Core, Python 기반의 CLI 는 API 함수로 만드는 비용이 적습니다.

Solution Items: 솔루션 공용 파일

• Visual Studio 솔루션 레벨에서 사용하는 공용 파일들을 모아놓은 논리적 디렉토리입니다.
• .gitignore나 Dockerfile, install, publish 스크립트 같이 솔루션 전체에 적용되는 파일들이 위치합니다.
• 비유하자면, 모든 부서원이 반드시 참고해야 하는 ‘회사 공통 규정집’입니다.

직접 확인해보기

이제 Visual Studio에서 프로젝트를 직접 열어 구조를 살펴봅시다.

1. Visual Studio 2022 Community를 실행합니다.
2. $(HANDSTACK_SRC)/handstack.sln 파일을 엽니다.
3. 솔루션 탐색기에서 오늘 배운 디렉토리들을 찾아보세요.
4. 각 디렉토리의 역할과 설명을 마음속으로 매칭시켜 봅니다.

다시 보는 디렉토리 역할 정리하기

업무의 핵심 모듈 라이브러리

• HandStack의 백엔드는 모듈러 모놀리식 아키텍처를 기반으로 합니다.
• 각 모듈은 독립적으로 개발하고 배포할 수 있는 작은 애플리케이션과 같습니다.
• 모듈들이 모여 하나의 큰 애플리케이션(ack 서버)을 구성합니다.
• 이 모듈의 서버 측 구성 요소들을 살펴보겠습니다.

아키텍처 간단 비교

HandStack은 모놀리식의 단순함과 마이크로서비스의 장점을 결합한 모듈러 모놀리식을 채택하여 개발 생산성과 유지보수성을 높였습니다.

HandStack 아키텍처에 대한 자세한 내용은 모듈러 모놀리식 아키텍처을 참고하세요.

여러 개의 독립된 모듈로 구분된 애플리케이션

• 모듈러 모놀리식은 애플리케이션의 도메인을 더 작고 관리하기 쉬운 컴포넌트 또는 모듈로 나누는 아키텍처 접근법 입니다.
• 코드베이스를 논리적이고 구조적인 디렉토리로 구성해서, 시스템 기능 간의 관심사를 분리하고 경계를 명확하게 합니다.

애플리케이션 아키텍처 예시

• 단일 호스트
  • ack + (wwwroot/transact/dbclient/graphclient/function/command/prompter/repository/logger/checkup/forwarder)
• 2 개 호스트
  • ack + (wwwroot/transact/checkup)
  • ack + (dbclient/graphclient/function/command/prompter/repository/logger/forwarder)
• 3 개 호스트
  • ack + (wwwroot/transact)
  • ack + (dbclient/graphclient/function/command/prompter)
  • ack + (repository/logger/checkup/forwarder)

고성능의 단일 호스트에 Port 를 다르게 구성하여 마이크로서비스 구성이 가능합니다.

모듈 프로젝트의 SDK 개념

.NET Core 프로젝트의 모듈 프로젝트 SDK는 컴포넌트 기반 UI, Razor Pages, Blazor 컴포넌트를 ASP.NET Core의 모든 기능을 사용 가능한 라이브러리 형태로 개발합니다.

애플리케이션을 위해 필요한 주요 기능

비즈니스 요구사항에 맞게 기능을 개발 하기 위해 다음의 기능들을 하나 또는 각각의 module 단위로 개발 할 수 있습니다.

• Database CRUD 거래
• Graph 데이터 조회와 관계 분석
• 외부 시스템과 연동을 위한 기능 개발
• CLI, Web URL, LLM 프롬프트 호출
• 클라이언트 인증 및 권한
• 파일 업로드/다운로드 기능
• 화면 개발에 필요한 UI 컴포넌트

이외에도 모니터링, 장애 확인등등 안정적인 운영을 위해 다양한 부가 기능들을 고려해야 합니다.

공식 modules

HandStack은 이러한 애플리케이션을 개발하기 위한 부분을 논리적으로 추상화하여 module로 개발 및 제공합니다.

규모에 따른 어플리케이션 모듈 구성

느슨하게 결합된 모듈을 만들 수 있고, 인터페이스를 일관되게 유지 할 수 있으며, 향후 마이크로서비스 아키텍처로 전환 할 경우에도 유리하게 작용될 수 있습니다.

개발/운영 비용 간 균형 잡기

기술의 상향 평준화는 개발 비용이 낮아지고, 운영 비용이 증가합니다.

• 개발 단계: .NET Core의 크로스플랫폼, CLI, SDK 프로젝트, 최신 언어 기능, AI 지원원 → 저비용, 고속 개발 가능
• 운영 단계: 사용자가 늘어날수록 인프라, 모니터링, 백업, 스케일링, 보안, 법적 대응 등 운영비용 지속 증가

고객의 요구에 맞춰 셀프 호스트, 클라우드, 하이브리드 방식의 개발과 운영을 해야합니다.

요약 정리 및 Q&A

• 모듈은 완전히 독립적이지 않습니다.
• 다른 모듈과의 종속성은 프로그램 수준에서 관리되어야 합니다.
• 모듈 코드를 재사용할 수 있습니다.
• 기존의 모놀리식보다 유지 관리하고 개발하기가 쉽습니다.
• 배포를 위해 전체 프로젝트를 단일 단위로 유지할 수 있습니다.
• 기존의 모놀리식보다 확장성이 뛰어납니다.
• 마이크로서비스 아키텍처보다 덜 복잡합니다.